/*
 * Copyright (C) 2021-2021 Huawei Technologies Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sermant.core.config.common;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * General field key annotation
 * <p>A property that modifies the configuration object and builds the configuration information key together with
 * the ConfigTypeKey
 * <p>The main purpose is to correct the differences between member attributes and configuration keys
 * <p> see ConfigKeyUtil#getFieldKey(java.lang.reflect.Field)
 *
 * @author HapThorin
 * @version 1.0.0
 * @since 2021-08-19
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface ConfigFieldKey {
    /**
     * Attribute name
     *
     * @return Attribute name
     */
    String value();
}
